docs(rules): find every user type and its actions in a Spec by zolotokrylin · Pull Request #148 · holdex/developers

zolotokrylin · 2026-08-10T07:43:42Z

DEV-125 asks for ## User Types and ## Key Concepts, but says nothing about what belongs in them. In practice this leaves gaps: a spec lists the client-facing user types and omits the operator or administrator ones, the account that creates all the others goes undocumented because it is seeded rather than created in the app, and actions get written without naming who is allowed to perform them, so a reviewer cannot check the spec against what the product actually permits.

This surfaced while documenting the Curia Regis user docs, where the System Administrator, the account that creates consultants and onboards companies, appeared nowhere.

What changed

docs/rules/DEV-125.md only:

Three new Solution steps: cover every user type including operators and administrators, say how an externally provisioned account comes into existence, treat the user account as a key concept rather than a separate administration area, and name the permitted user type in every action.
The template block's ## User Types and ## Key Concepts guidance updated to match.
Three matching acceptance criteria.

For the reviewer

No other rule changes. One pre-existing inconsistency left untouched: the Solution and acceptance criteria call for ## Overview, while the template block has ## Objective and ## Key results. Worth a separate fix if you agree it is a mismatch.

Summary by CodeRabbit

Documentation
- Updated the specification template to require comprehensive user-type definitions, including operators and administrators.
- Added guidance for externally provisioned accounts and product-supported account creation.
- Documented user-account actions such as creating, listing, accessing, and removing accounts.
- Added acceptance criteria requiring permissions to be identified for each action.

coderabbitai · 2026-08-10T07:43:51Z

Warning

Review limit reached

@zolotokrylin, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 53 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: a4664ba9-9298-4917-9c1b-2407af7b0222

📥 Commits

Reviewing files that changed from the base of the PR and between 001bf94 and 703f125.

📒 Files selected for processing (1)

docs/rules/DEV-125.md

Walkthrough

The Spec template rule now requires documentation for all user types, account provisioning, user-account actions, permitted actors, and related acceptance criteria.

Changes

Spec template requirements

Layer / File(s)	Summary
User account documentation requirements `docs/rules/DEV-125.md`	The template now covers all user types, externally provisioned accounts, user-account actions, permitted actors, examples, and acceptance criteria.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

holdex/developers#124: Introduced the Spec-template rule that this change extends.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the main change: documenting every user type and its permitted actions in a Spec.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch docs/spec-template-user-types

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

holdex · 2026-08-10T07:43:54Z

Time Submission Status

Member	#	Time	Running Total	Status	Last Update
zolotokrylin			9min	✅ Submitted	Aug 10, 2026, 8:00 AM

Submit or update total time with:

@holdex pr submit-time 2h

Add time on top of previous submission with:

@holdex pr add-time 1h30m

See available commands to help comply with our Guidelines.

zolotokrylin

@holdex pr add-time 9m

coderabbitai

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/rules/DEV-125.md`:
- Around line 61-64: Update the DEV-125 guidance to use “users” or “each
permitted user type” instead of “end-user,” including the Key Concepts
requirement and the user account actions, so the rule applies to operators and
administrators as well.
- Around line 75-78: Update the `User Types` acceptance criterion in `DEV-125`
to explicitly require stating whether the product can create additional accounts
of each externally provisioned user type. Preserve the existing requirements
covering all user types, including operators and administrators, and describing
how externally provisioned accounts come into existence.

🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 8c19e5d9-6ed5-4f37-90a5-a68b4a8f8c63

📥 Commits

Reviewing files that changed from the base of the PR and between ad35cdc and 001bf94.

📒 Files selected for processing (1)

docs/rules/DEV-125.md

docs(rules): find every user type and its actions in a Spec

001bf94

zolotokrylin self-assigned this Aug 10, 2026

zolotokrylin commented Aug 10, 2026

View reviewed changes

zolotokrylin marked this pull request as ready for review August 10, 2026 08:00

coderabbitai Bot reviewed Aug 10, 2026

View reviewed changes

Comment thread docs/rules/DEV-125.md Outdated

Comment thread docs/rules/DEV-125.md

docs(rules): read the Key Concepts guidance as covering every user type

703f125

zolotokrylin merged commit de87f58 into main Aug 10, 2026
4 checks passed

zolotokrylin deleted the docs/spec-template-user-types branch August 10, 2026 08:07

Navigation Menu

Uh oh!

docs(rules): find every user type and its actions in a Spec - #148

docs(rules): find every user type and its actions in a Spec#148
zolotokrylin merged 2 commits into
mainfrom
docs/spec-template-user-types

zolotokrylin commented Aug 10, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Aug 10, 2026 •

edited

Loading

Review limit reached

Uh oh!

holdex Bot commented Aug 10, 2026 •

edited

Loading

Uh oh!

zolotokrylin left a comment

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

zolotokrylin commented Aug 10, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changed

For the reviewer

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Aug 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review limit reached

Walkthrough

Changes

Uh oh!

holdex Bot commented Aug 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Time Submission Status

Uh oh!

zolotokrylin left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

zolotokrylin commented Aug 10, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Aug 10, 2026 •

edited

Loading

holdex Bot commented Aug 10, 2026 •

edited

Loading